Alteryx Serverでバックアップを取得して、2022.3バージョンへアップグレードを行ってみました
こんにちは、アライアンス統括部の清水です。
今日はAlteryx Serverのバージョンアップに関して記載したいと思います。事前にAlteryx Serverのバックアップを取得してから行ってみたいと思います。
前提条件
- Alteryx Server 2022.1（バージョンアップ前）
- Alteryx Server 2022.3（バージョンアップ後）
- Windows Server 2019 Datacenter on AWS EC2
Alteryx Serverのバックアップを取得する
Alteryx Communityでも以下のナレッジベースが公開されています。
Alteryx Serverはデフォルトの場合、埋め込みのMongoDBを使用しています。Alteryx ServerにアップロードしたワークフローなどのアセットやCollection、スケジュールなどのデータはすべてこのMongoDBに集約されています。万が一の場合にはこのMongoDBのバックアップから復旧させることでこれまでの情報を引き続き使用可能となります。
MongoDBのバックアップ
- Alteryx Serviceを停止する
- MongoDBのフォルダのバックアップをコマンドプロンプトからコマンド実行で取得
- Alteryx Serviceを起動する
タクスマネージャーからServiceを起動し、Alteryx Serviceを右クリック→Stopで停止します。
停止状態になったのを確認したあと、コマンドプロンプトから以下のコマンドを入力します。
C:\Program Files\Alteryx\bin>alteryxservice emongodump=C:\Users\Administrator\Documents\MongoDBBackUp_2023
成功すると以下のように表示されます。
C:\Program Files\Alteryx\bin>alteryxservice emongodump=C:\Users\Administrator\Documents\MongoDBBackUp_2023 Command line: "C:\Program Files\Alteryx\bin\AlteryxService_MongoController.exe" MongoRoot="C:\Program Files\Alteryx\bin\\" DBName=AlteryxService DBRoot="C:\ProgramData\Alteryx\Service\Persistence\MongoDB" Port=27100 IPV6=False DumpPath="C:\Users\Administrator\Documents\MongoDBBackUp_2023" EMongoDump running....finished. C:\Program Files\Alteryx\bin>
指定したパスにMongoDBのバックアップが作成されていることを確認します。
確認ができたらAlteryx Serviceを右クリック→Startで再度起動しておきます。
ステータスがRunningになれば作業終了です。
Alteryx Serverのバージョンアップを行う前に
2022.3 バージョン
最新の2022.3のバージョンは、以下に記載されている通りAlteryx Designerのバージョンも2022.3で作成されたWFでなければ共有が出来ないためアップグレードの際にはご注意ください。
なおサーバーのアップグレードにあたり、Alteryx社のほうで移行準備ツール（Migration Prep Tool）を用意しているため、公式記事のFAQに該当される場合は、ご利用することをお勧めいたします。
WFの数が少ない場合や、バージョンアップにかかる時間を気にしないといった場合は、Migration Prep Toolはご利用されなくても構いません。今回は、Migration Prep Toolを利用したのちに、バージョンアップを行ってみます。
Migration Prep Toolの操作手順
Migration Prep Toolのインストール
インストーラーを実行します。
画面に沿って進み、完了までいくとFinishが表示されます。
Migration Prep Toolの起動
コマンドプロンプト、またはWindows PowerShellを開き、Alteryx Migration Toolのディレクトリへ移動します。
C:\Program Files>cd "Alteryx Migration Tool"
MigrationするMongodbを指定します、こちらの詳細は以下の公式記事の【Step 2: Start the Migration Prep Tool】を参考になさってください。
Alteryx ServerのSystem Settings内に、このように情報があるので実際に設定する内容を確認できます。アカウント情報やDatabase typeなどがご利用されている状況により異なるため、以下のスクリーンショットは一例になります。
System Settingsにある情報を確認後、公式の記事に沿ってコマンドを実行します。
C:\Program Files\Alteryx Migration Tool>AlteryxServiceMigrator22_2.exe -p -c "mongodb://user:XXXXXX@localhost:XXXX/AlteryxService?authSource=XXXX"
その後バックアップを取得したかどうかと、容量に十分なスペースがあるか確認されるので、Yと答えて進みます。
Please ensure you have made a backup of your Database and Runtime Settings files. Enter Y when you are ready to proceed, or any other input to cancel. Y This migration will require approximately <191> MB of additional space in the target mongo instance. Please confirm that much space is available in the target instance and then enter Y to proceed, or any other input to cancel. Y
すると、migrationが実行されます。
2023-03-03 08:04:46.660050;6;Begining <Migration to 22.3> migration at <2023-03-03 08:04:46 Coordinated Universal Time> local time 2023-03-03 08:04:46.660096;6;Begining <AppChunk migration> migration at <2023-03-03 08:04:46 Coordinated Universal Time> local time 2023-03-03 08:04:49.178453;5;App migration is approximately 0% complete. Migrating app <1> of <556>. 2023-03-03 08:04:51.721425;5;App migration is approximately 1% complete. Migrating app <5> of <556>. 2023-03-03 08:04:52.268434;5;App migration is approximately 2% complete. Migrating app <10> of <556>. 2023-03-03 08:05:53.667301;5;App migration is approximately 99% complete. Migrating app <550> of <556>. 2023-03-03 08:05:53.850848;5;App migration is approximately 100% complete. Migrating app <555> of <556>. 2023-03-03 08:05:53.925928;6;Ending <AppChunk migration> migration at <2023-03-03 08:05:53 Coordinated Universal Time> local time. Total duration was approximately <67> seconds 2023-03-03 08:05:53.925946;6;Ending <Migration to 22.3> migration at <2023-03-03 08:05:53 Coordinated Universal Time> local time. Total duration was approximately <67> seconds C:\Program Files\Alteryx Migration Tool>
Alteryx Serverのアップデート
インストーラをダウンロード
インストーラーをダウンロードします。
この時、バージョンが古いAlteryx Designerがご利用中のサーバー環境にインストールされていた場合、このような忠告がでてきます。
「Yes」をクリックし、進めるとAlteryx Designerのアンインストールが行われます。
その後、インストーラーが起動します。
インストールを進めます。
完了すると、このように表示されるため「Configure Server Now」をクリックします。この時、Alteryx Designerも一緒に最新バージョンのものがインストールされるため、Predictive toolsをご利用されていた場合は、「Install Predictive Tools」を選択ください。
Finishをクリックすると、次にSystem Settingsが表示されますので、以前の状態と同じか確認します。
「Finish」をクリックすると、Serviceが開始され、メンテナンスモードになります。この間サーバーはご利用いただけなくなります。
すべて完了すると、このように表示されます。
GallayのProfileページから、バージョンが更新されていることを確認できました。
MongoDBが破損して、バックアップからの復旧を余儀なくされた場合
過去のブログ記事にありますように、事前にバックアップしておいたデータをリストアすることにより復旧出来ます。
バージョンアップする前に準備を！Alteryx Serverでバックアップを取得してMongoDBを復旧させてみた
終わりに
Migration Prep Toolを利用したのちに、バージョンアップを行うと、検証環境ではメンテナンスモードの状態が５－１０分程度でバージョンアップが完了しました。Alteryx Serverのアップデートは、MongoDBのバックアップを取得するなど事前準備が割と大変ですので、実際に作業を行う際にはスケジュールをたてて行うことをお勧めいたします。
どなたかのお役に立てば幸いです。
